Esx Settings Clusters Configuration ClusterCompliance

Esx Settings Clusters Configuration ClusterCompliance
Esx Settings Clusters Configuration ClusterCompliance

This Esx Settings Clusters Configuration ClusterCompliance schema contains properties that describe the compliance result for each host in the cluster as well as overall cluster compliance status.

This schema was added in vSphere API 8.0.1.0.

JSON Example
{
    "cluster_status": "string",
    "commit": "string",
    "software_commit": "string",
    "summary": {
        "id": "string",
        "default_message": "string",
        "args": [
            "string"
        ],
        "params": {
            "params": {
                "s": "string",
                "dt": "string",
                "i": 0,
                "d": "number",
                "l": "Vapi Std NestedLocalizableMessage Object",
                "format": "string",
                "precision": 0
            }
        },
        "localized": "string"
    },
    "validation_errors": [
        {
            "path": "string",
            "messages": [
                {
                    "id": "string",
                    "default_message": "string",
                    "args": [
                        "string"
                    ],
                    "params": {
                        "params": {
                            "s": "string",
                            "dt": "string",
                            "i": 0,
                            "d": "number",
                            "l": "Vapi Std NestedLocalizableMessage Object",
                            "format": "string",
                            "precision": 0
                        }
                    },
                    "localized": "string"
                }
            ]
        }
    ],
    "host_info": {
        "host_info": {
            "name": "string",
            "is_vsan_witness": false
        }
    },
    "hosts": {
        "hosts": {
            "host_status": {
                "status": "string",
                "attempts": 0,
                "remaining_retries": 0,
                "start_time": "string",
                "end_time": "string",
                "notifications": {
                    "info": [
                        {
                            "type": "string",
                            "id": "string",
                            "time": "string",
                            "message": {
                                "id": "string",
                                "default_message": "string",
                                "args": [
                                    "string"
                                ],
                                "params": {
                                    "params": {
                                        "s": "string",
                                        "dt": "string",
                                        "i": 0,
                                        "d": "number",
                                        "l": "Vapi Std NestedLocalizableMessage Object",
                                        "format": "string",
                                        "precision": 0
                                    }
                                },
                                "localized": "string"
                            },
                            "resolution": {
                                "id": "string",
                                "default_message": "string",
                                "args": [
                                    "string"
                                ],
                                "params": {
                                    "params": {
                                        "s": "string",
                                        "dt": "string",
                                        "i": 0,
                                        "d": "number",
                                        "l": "Vapi Std NestedLocalizableMessage Object",
                                        "format": "string",
                                        "precision": 0
                                    }
                                },
                                "localized": "string"
                            },
                            "originator": "string",
                            "retriable": false
                        }
                    ],
                    "warnings": [
                        {
                            "type": "string",
                            "id": "string",
                            "time": "string",
                            "message": {
                                "id": "string",
                                "default_message": "string",
                                "args": [
                                    "string"
                                ],
                                "params": {
                                    "params": {
                                        "s": "string",
                                        "dt": "string",
                                        "i": 0,
                                        "d": "number",
                                        "l": "Vapi Std NestedLocalizableMessage Object",
                                        "format": "string",
                                        "precision": 0
                                    }
                                },
                                "localized": "string"
                            },
                            "resolution": {
                                "id": "string",
                                "default_message": "string",
                                "args": [
                                    "string"
                                ],
                                "params": {
                                    "params": {
                                        "s": "string",
                                        "dt": "string",
                                        "i": 0,
                                        "d": "number",
                                        "l": "Vapi Std NestedLocalizableMessage Object",
                                        "format": "string",
                                        "precision": 0
                                    }
                                },
                                "localized": "string"
                            },
                            "originator": "string",
                            "retriable": false
                        }
                    ],
                    "errors": [
                        {
                            "type": "string",
                            "id": "string",
                            "time": "string",
                            "message": {
                                "id": "string",
                                "default_message": "string",
                                "args": [
                                    "string"
                                ],
                                "params": {
                                    "params": {
                                        "s": "string",
                                        "dt": "string",
                                        "i": 0,
                                        "d": "number",
                                        "l": "Vapi Std NestedLocalizableMessage Object",
                                        "format": "string",
                                        "precision": 0
                                    }
                                },
                                "localized": "string"
                            },
                            "resolution": {
                                "id": "string",
                                "default_message": "string",
                                "args": [
                                    "string"
                                ],
                                "params": {
                                    "params": {
                                        "s": "string",
                                        "dt": "string",
                                        "i": 0,
                                        "d": "number",
                                        "l": "Vapi Std NestedLocalizableMessage Object",
                                        "format": "string",
                                        "precision": 0
                                    }
                                },
                                "localized": "string"
                            },
                            "originator": "string",
                            "retriable": false
                        }
                    ]
                }
            },
            "summary": {
                "id": "string",
                "default_message": "string",
                "args": [
                    "string"
                ],
                "params": {
                    "params": {
                        "s": "string",
                        "dt": "string",
                        "i": 0,
                        "d": "number",
                        "l": "Vapi Std NestedLocalizableMessage Object",
                        "format": "string",
                        "precision": 0
                    }
                },
                "localized": "string"
            },
            "errors": [
                {
                    "path": "string",
                    "messages": [
                        {
                            "id": "string",
                            "default_message": "string",
                            "args": [
                                "string"
                            ],
                            "params": {
                                "params": {
                                    "s": "string",
                                    "dt": "string",
                                    "i": 0,
                                    "d": "number",
                                    "l": "Vapi Std NestedLocalizableMessage Object",
                                    "format": "string",
                                    "precision": 0
                                }
                            },
                            "localized": "string"
                        }
                    ]
                }
            ],
            "host_compliance": {
                "status": "string",
                "compliance_info": {
                    "sets": [
                        {
                            "path": "string",
                            "display_path": [
                                "string"
                            ],
                            "current": "string",
                            "target": "string",
                            "type": "string",
                            "reference_current": "string",
                            "reference_target": "string"
                        }
                    ],
                    "adds": [
                        {
                            "path": "string",
                            "display_path": [
                                "string"
                            ],
                            "current": "string",
                            "target": "string",
                            "type": "string",
                            "reference_current": "string",
                            "reference_target": "string"
                        }
                    ],
                    "deletes": [
                        {
                            "path": "string",
                            "display_path": [
                                "string"
                            ],
                            "current": "string",
                            "target": "string",
                            "type": "string",
                            "reference_current": "string",
                            "reference_target": "string"
                        }
                    ]
                }
            }
        }
    },
    "compliant_hosts": [
        "string"
    ],
    "non_compliant_hosts": [
        "string"
    ],
    "failed_hosts": [
        "string"
    ],
    "skipped_hosts": [
        "string"
    ],
    "end_time": "string"
}
string
cluster_status
Required

Consolidated status of all host compliance checks.

For more information see: Esx Settings Clusters Configuration ClusterCompliance Status.

This property was added in vSphere API 8.0.1.0.

string
commit
Optional

This identifier refers to the commit action of importing the desired configuration document. It will not be set for a draft execution of check compliance.

This property was added in vSphere API 8.0.1.0.

When clients pass a value of this schema as a parameter, the property must be an identifier for the resource type: com.vmware.esx.settings.commit. When operations return a value of this schema as a response, the property will be an identifier for the resource type: com.vmware.esx.settings.commit.

string
software_commit
Required

The current commit ID for the software associated with the cluster.

This property was added in vSphere API 8.0.1.0.

When clients pass a value of this schema as a parameter, the property must be an identifier for the resource type: com.vmware.esx.settings.commit. When operations return a value of this schema as a response, the property will be an identifier for the resource type: com.vmware.esx.settings.commit.

summary
Required

Summarizing check compliance operation on the hosts in the cluster.

This property was added in vSphere API 8.0.1.0.

validation_errors
Optional

This field represents the validation errors if the desired configuration specified is not valid.

This property was added in vSphere API 8.0.3.0.

This field may be set if Esx Settings Clusters Configuration ClusterCompliance.cluster_status is NOT_COMPLIANT due to validation errors.

object
host_info
Required

Map of host IDs to hostname.

This property was added in vSphere API 8.0.1.0.

When clients pass a value of this schema as a parameter, the key in the property map must be an identifier for the resource type: HostSystem. When operations return a value of this schema as a response, the key in the property map will be an identifier for the resource type: HostSystem.

object
hosts
Required

Map of host IDs to their compliance results.

This property was added in vSphere API 8.0.1.0.

When clients pass a value of this schema as a parameter, the key in the property map must be an identifier for the resource type: HostSystem. When operations return a value of this schema as a response, the key in the property map will be an identifier for the resource type: HostSystem.

array of string
compliant_hosts
Required

Identifiers of compliant hosts.

This property was added in vSphere API 8.0.1.0.

When clients pass a value of this schema as a parameter, the property must contain identifiers for the resource type: HostSystem. When operations return a value of this schema as a response, the property will contain identifiers for the resource type: HostSystem.

array of string
non_compliant_hosts
Required

Identifiers of non-compliant hosts.

This property was added in vSphere API 8.0.1.0.

When clients pass a value of this schema as a parameter, the property must contain identifiers for the resource type: HostSystem. When operations return a value of this schema as a response, the property will contain identifiers for the resource type: HostSystem.

array of string
failed_hosts
Required

Identifiers of hosts where the operation failed.

This property was added in vSphere API 8.0.1.0.

When clients pass a value of this schema as a parameter, the property must contain identifiers for the resource type: HostSystem. When operations return a value of this schema as a response, the property will contain identifiers for the resource type: HostSystem.

array of string
skipped_hosts
Required

Identifiers of hosts where the operation was skipped. i.e disconnected hosts

This property was added in vSphere API 8.0.1.0.

When clients pass a value of this schema as a parameter, the property must contain identifiers for the resource type: HostSystem. When operations return a value of this schema as a response, the property will contain identifiers for the resource type: HostSystem.

string As date-time As date-time
end_time
Required

CheckCompliance completion time.

This property was added in vSphere API 8.0.1.0.